Upgrade to Wagtail 6.2 #8522
Merged
Upgrade to Wagtail 6.2 #8522
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
willbarton
force-pushed
the
upgrade/wagtail62
branch
2 times, most recently
from
b031f89 to
430c0a7
Compare
2 tasks
willbarton
force-pushed
the
upgrade/wagtail62
branch
from
430c0a7 to
4c242e6
Compare
chosak
reviewed
Aug 16, 2024
willbarton
force-pushed
the
upgrade/wagtail62
branch
4 times, most recently
from
dc6d70b to
44b0ce4
Compare
willbarton
force-pushed
the
upgrade/wagtail62
branch
2 times, most recently
from
db3d1e1 to
848c2b8
Compare
chosak
reviewed
Aug 26, 2024
chosak
reviewed
Aug 27, 2024
cfgov/cfgov/settings/base.py
Outdated
| "CLIENT_TOKEN": os.environ.get("AKAMAI_CLIENT_TOKEN"), | ||
| "CLIENT_SECRET": os.environ.get("AKAMAI_CLIENT_SECRET"), | ||
| "ACCESS_TOKEN": os.environ.get("AKAMAI_ACCESS_TOKEN"), | ||
| "HOSTNAMES": ["www.consumerfinance.gov"], |
There was a problem hiding this comment.
Is this a problem for beta.consumerfinance.gov, which has its own Akamai configuration?
There was a problem hiding this comment.
Moved this to a variable in base.py for both Akamai and Cloudfront. Will have a corresponding Ansible PR presently.
willbarton
force-pushed
the
upgrade/wagtail62
branch
3 times, most recently
from
24c6379 to
c45079c
Compare
chosak
approved these changes
Sep 4, 2024
`WAGTAIL_USER_CREATION_FORM` and `WAGTAIL_USER_EDIT_FORM` are deprecated in favor of subclassing Wagtail's `UserViewSet` class and providing a custom `WagtailUserAppConfig` class that overrides that of `wagtail.users`. See https://docs.wagtail.org/en/latest/releases/6.2.html#deprecation-of-wagtail-user-edit-form-wagtail-user-creation-form-and-wagtail-user-custom-fields-settings This is... not my favorite bit of Django code, and feels a little anti-idiomatic. Effectively what happens here is that the `LoginUsersAppConfig` that we define (alongside `LoginConfig` — it doesn't work when combined) both allows us to override `user_viewset` and provide our own ***AND*** replaces that of `wagtail.users`, so that `login.apps.LoginUsersAppConfig` masquerades as `wagtail.users` for the sake of Django's app registration. But this is the direction Wagtail has gone for user and group viewset overrides 🤷🏻♂️.
A dict of distribution ids for CloudFront is deprecated in Wagtail 6.2. We were only using a dict for a single distribution ID, so this isn't terribly impactful but does require us to change our configuration format slightly. See https://docs.wagtail.org/en/latest/releases/6.2.html#specifying-a-dict-of-distribution-ids-for-cloudfront-cache-invalidation-is-deprecated fixy cloud
This change updates our CDN tools, AkamaiBackend, etc, for the Wagtail 6.2 changes in frontend caching. It also moves all our CDN tools and frontend caching to a separate package outside of v1 to isolate the functionality.
Wagtail 6.2 changes reports to use the new universal listing templates. This necessitates several changes, outlined in the release notes here: https://docs.wagtail.org/en/latest/releases/6.2.html#changes-to-report-views-with-the-new-universal-listings-ui This change makes all of these required changes to our existing reports and report templates. In the process, I have also removed the "no-XSLX" base template and option; all our reports are now available as both CSV and XSLX. fix http
willbarton
force-pushed
the
upgrade/wagtail62
branch
from
07f3ebe to
c52572f
Compare
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
willbarton
added a commit
that referenced
this pull request
Sep 9, 2024
This change fixes the `invalidate_page_cache` management command after the changes for Wagtail 6.2 in #8522.
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR upgrades us to Wagtail 6.2.
There are a few changes worth noting:
Custom
UserViewSetin place of user creation, edit form settingsWAGTAIL_USER_CREATION_FORMandWAGTAIL_USER_EDIT_FORMare deprecated in favor of subclassing Wagtail'sUserViewSetclass and providing a customWagtailUserAppConfigclass that overrides that ofwagtail.users. See https://docs.wagtail.org/en/latest/releases/6.2.html#deprecation-of-wagtail-user-edit-form-wagtail-user-creation-form-and-wagtail-user-custom-fields-settingsThis is... not my favorite bit of Django code, and feels a little anti-idiomatic. Effectively what happens here is that the
LoginUsersAppConfigthat we define (alongsideLoginConfig— it doesn't work when combined) both allows us to overrideuser_viewsetand provide our own AND replaces that ofwagtail.users, so thatlogin.apps.LoginUsersAppConfigmasquerades aswagtail.usersfor the sake of Django's app registration. But this is the direction Wagtail has gone for user and group viewset overrides 🤷🏻♂️.Updated reports
Wagtail 6.2 changes reports to use the new universal listing templates. This necessitates several changes, outlined in the release notes here: https://docs.wagtail.org/en/latest/releases/6.2.html#changes-to-report-views-with-the-new-universal-listings-ui
This change makes all of these required changes to our existing reports and report templates.
In the process, I have also removed the "no-XSLX" base template and option; all our reports are now available as both CSV and XSLX.
Reorganized CDN tools code
Wagtail 6.2 makes minor updates to the frontend cache API beyond the documented CloudFront changes. While updating our caching code, I've moved it out of
v1and isolated it in its own Django app,cdntools. This code is mostly as it was, aside from adding aCACHED_URLSparameter to ourMockCacheBackend.Finally, we still have a RemovedInWagtail70Warning: The usage of WidgetWithScript hook is deprecated. Use external scripts instead. warning that will be fixed by wagtail/wagtail-autocomplete#180 when (if?) it gets merged (hopefully before Wagtail 7.0 🤞🏻).
Checklist